home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 002 / pckat12.arc / TECHREF.OUT < prev   
Encoding:
Text File  |  1986-03-17  |  14.9 KB  |  397 lines
  1.  
  2.                                     PC-KAT (TM)
  3.  
  4.                             The Easy, Practical, Super
  5.                             Capacity Diskette Cataloger
  6.  
  7.  
  8.                             TECHNICAL REFERENCE MANUAL
  9.  
  10.  
  11.                                         by
  12.                                     R.H. Martin
  13.  
  14.  
  15.                               Applied Foresight (TM)
  16.                                   P.O. Box 20607
  17.                              Bloomington, Minn.  55420
  18.  
  19.                                  January 17, 1986
  20.                                     Version 1.2
  21.  
  22.  
  23.  
  24.                            Copyright 1986 by R.H. Martin
  25.                                 All Rights Reserved
  26.  
  27.  
  28.  
  29.                             A DB-SHARE Software Product
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                     A limited license is hereby granted to copy
  37.                   and distribute wholly unmodified copies of the
  38.                 PC-KAT Software Diskette which contains this manual
  39.  
  40.                      (Read the manual, "THE DB-SHARE PROGRAM"
  41.                    for full details about this limited license)
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.                                                              Trademark Pending
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.      TECHNICAL REFERENCE MANUAL     Copyright 1986 R.H. Martin     Page 2
  69.  
  70.  
  71.  
  72.                                  TABLE OF CONTENTS
  73.  
  74.      Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  75.      About This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  76.      Using PC-KAT With Tall Tree Systems' JET Program. . . . . . . . . . . . 2
  77.      Efficiency Of PC-KAT . . . . . . . . . .. . . . . . . . . . . . . . . . 2
  78.      PC-KAT Inquiry Search Strategies. . . . . . . . . . . . . . . . . . . . 4
  79.      Recovering Your Database. . . . . . . . . . . . . . . . . . . . . . . . 5
  80.  
  81.  
  82.                                  ABOUT THIS MANUAL
  83.  
  84.      With the exception of the Registration Benefits section, this manual
  85.      restricts itself to the base PC-KAT software diskette.  The concept of
  86.      "base software" is discussed in greater detail in the THE DB-SHARE
  87.      PROGRAM manual.
  88.  
  89.      A section is designated by a centered and underlined heading.  Centered
  90.      but NOT underlined headings are referred to as a subsection.
  91.  
  92.  
  93.                               USING PC-KAT WITH TALL
  94.                              TREE SYSTEMS' JET PROGRAM
  95.  
  96.      PC-KAT also catalogs, without requiring any data entry, the subdirectory
  97.      which a diskette file resides in.  This is a feature that many owners of
  98.      the high speed copy utility, JET by Tall Tree Systems, will appreciate.
  99.      JET is able to copy files to diskettes and preserved their subdirectory
  100.      location on the targeted (diskette) volume.  Many IBM AT owners may
  101.      appreciate this PC-KAT feature too.  With the 1.2 MB capacity floppies,
  102.      there is increasing use of making subdirectories on floppies.  You do not
  103.      need JET nor an IBM AT to make subdirectories on your floppies.  Just
  104.      type: MD A:\SUBDIR and press ENTER to create the directory called,
  105.      \SUBDIR, on drive A.
  106.  
  107.      JET is one of the programs available on the JETDRIVE diskette, which
  108.      includes a super RAM Disk software for the IBM PC and compatibles.
  109.      JETDRIVE retails for $60 and is available by Tall Tree Systems, 1032
  110.      Elwell Court, Suite 124, Palo Alto, CA 94303.  Some mail order houses,
  111.      like Applied Computer Products, Inc., 1-800-223-3860, sell JETDRIVE for
  112.      as little as $40.
  113.  
  114.  
  115.                                EFFICIENCY OF PC-KAT
  116.  
  117.      PC-KAT is fast and efficient, minimizing the amount of disk space
  118.      required to store the cataloged information.  Each date and time field is
  119.      concatenated together and stored as a 4 byte long integer.  In plain
  120.      words, what you see on the screen as 10 bytes of information is stored in
  121.      4 bytes of storage.  The four byte volume ID is stored as a 2 byte
  122.      integer.  If a diskette filename is associated with a floppy
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.      TECHNICAL REFERENCE MANUAL     Copyright 1986 R.H. Martin     Page 3
  135.  
  136.  
  137.      subdirectory, the directory name is separately stored in the database
  138.      only once in its alphabetical description form, and given an ID number.
  139.      This ID number is carried in the appropriate individual filename records.
  140.  
  141.      The entire PC-KAT database is kept in the files prefixed as KATDB.DA and
  142.      KATDB.KE.  The database contains the system control record, the diskette
  143.      volume text information and the directory file information for all
  144.      cataloged files.  In addition, all the record pointers are stored in the
  145.      database to allow quick updating and retrieval of information.   The file
  146.      KATDB.DBD is the data base structure dictionary which never grows but is
  147.      needed for the programs to work and must reside in the same directory
  148.      area on the hard disk alongside the other KATDB files.
  149.  
  150.      What this means is that although PC-KAT must keep its inter-relationships
  151.      connected at the disk drive level versus smaller packages which do most
  152.      of their inter-relationships at runtime in memory, PC-KAT does not use up
  153.      hardly any more disk space, and that is because of its efficient use of
  154.      disk space.  Additionally, PC-KAT has to allow for its database pointers
  155.      to expand up to 16 million records.  What this means is that on the
  156.      average, PC-KAT uses up only 7 percent more space per cataloged directory
  157.      entry than does its competitors.
  158.  
  159.      The other packages gain their processing efficiency by storing the entire
  160.      database in memory at run time.  That is why they can't get larger,
  161.      because they are constrained by available program data memory space.
  162.      Yet, without significantly sacrificing additional disk space, PC-KAT uses
  163.      disk space to hold its pointers, and achieves comparable processing
  164.      efficiency on a catalog database capable of holding 16 million records.
  165.  
  166.      The author maintains for himself a PC-KAT database of over 12,800
  167.      filenames and around six hundred diskettes.
  168.  
  169.      Throughout the built-up of this database, the author has not noticed a
  170.      worsening of processing performance, except that a display request for a
  171.      floating substring phrase within any and all cataloged filenames does
  172.      take a little longer as the database grows.  To use the DOS DIR command
  173.      syntax to explain this type of search request, although DOS does not
  174.      honor such a search request, if it did, a request might look like this:
  175.      DIR *CAT*.  On a COMPAQ PLUS, with 8,000 filenames in a PC-KAT database,
  176.      it takes under 2 minutes for such a search to finish, whereas with 6,000
  177.      filenames, it takes under 1.5 minutes.  Search requests for left-hand
  178.      anchored substring phrases within any and all cataloged filenames is
  179.      extremely rapid, taking only a couple of seconds to fulfill.  A search
  180.      request at the DOS DIR level might look like: DIR CAT*.
  181.  
  182.      PC-KAT is fast because of the tools used in developing PC-KAT (discussed
  183.      earlier) and because of its streamlined design.  For instance, if you
  184.      have a diskette previously cataloged by PC-KAT, when you change, add or
  185.      delete a few files on the diskette, PC-KAT concentrates on these
  186.      modifications.  A less efficient design might start out the processing of
  187.      each diskette with the deletion of all prior database information for
  188.      that diskette.  Because of PC-KAT's usage of the sophisticated DB-VISTA
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.      TECHNICAL REFERENCE MANUAL     Copyright 1986 R.H. Martin     Page 4
  201.  
  202.  
  203.      database manager, it is able to immediately access prior information for
  204.      the at-hand diskette in the correct processing order in which it needs
  205.      it.  Finally, PC-KAT is fast because it allows the user to use a RAM disk
  206.      emulator to store the subprograms and work files for PC-KAT on the RAM
  207.      disk.
  208.  
  209.      PC-KAT is also fast because it is smart.  If you mistakenly insert a
  210.      diskette which hasn't changed since it was last processed by PC-KAT, you
  211.      are told this is the case.  PC-KAT keeps for each diskette both a numeric
  212.      total of the number of files on the diskette plus the sum of all dates +
  213.      all times + all file sizes of all the files on the diskette.  Before PC-
  214.      KAT considers updating directory entries for a diskette, it compares
  215.      these two new totals with the prior run's old totals.
  216.  
  217.  
  218.                          PC-KAT INQUIRY SEARCH STRATEGIES
  219.  
  220.      To understand the many ways you can search your PC-KAT database and how
  221.      efficient will be your search, you need to know how your PC-KAT database
  222.      is structured.  For searching purposes, you can think of the database
  223.      being ordered in two different ways:
  224.  
  225.      (a) by alphabetical, indexed, order by FILENAME.EXT, regardless of the
  226.          volume ID; and
  227.      (b) by numeric, indexed, order by volume ID, and within volume ID order,
  228.          subordered alphabetically, by FILENAME.EXT.
  229.  
  230.      The path information is carried in the database, but it has no ordering
  231.      effect in terms of aiding retrieval of information.
  232.  
  233.      Based upon the structure of PC-KAT's database design, the following
  234.      examples represent a range of searchs ordered by a most efficient search
  235.      argument to a least efficient search argument:
  236.  
  237.          FILENAME ARGUMENT TYPE   EXT ARGUMENT TYPE   PATH ARGUMENT TYPE
  238.          --------          -      ---          -      --------      -
  239.          MYFILE            E      DOC          E      MYPATH        E
  240.          MYFILE            E      DOC          E      MY            A
  241.          MYFILE            E      DOC          E      AT            U
  242.          MYFILE            E      D            A      <left blank>
  243.          MYFILE            E      O            U      <left blank>
  244.          MYFILE            E      <left blank>        <left blank>
  245.          MY                A      DOC          E      MYPATH        E
  246.          MY                A      DOC          E      MY            A
  247.          MY                A      DOC          E      AT            U
  248.          MY                A      D            A      <left blank>
  249.          MY                A      O            U      <left blank>
  250.          MY                A      <left blank>        <left blank>
  251.          FIL               U      DOC          E      MYPATH        E
  252.          FIL               U      DOC          E      MY            A
  253.          FIL               U      DOC          E      AT            U
  254.          FIL               U      D            A      <left blank>
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.      TECHNICAL REFERENCE MANUAL     Copyright 1986 R.H. Martin     Page 5
  267.  
  268.  
  269.          FIL               U      O            U      <left blank>
  270.        * FIL               U      <left blank>        <left blank>
  271.          <left blank>             DOC          E      MYPATH        E
  272.          <left blank>             DOC          E      MY            A
  273.          <left blank>             DOC          E      AT            U
  274.          <left blank>             D            A      <left blank>
  275.          <left blank>             O            U      <left blank>
  276.          <left blank>             <left blank>        MYPATH        E
  277.          <left blank>             <left blank>        MY            A
  278.          <left blank>             <left blank>        AT            U
  279.  
  280.      Don't be afraid to use the search strategy you need to accomplish the job
  281.      you want done.  For instance, against a database of 12,000 directory
  282.      entries, to search using an argument like the above line with an asterick
  283.      preceeding it, took around two and a half minutes.  This search argument
  284.      causes the entire database to be scanned from start to end.
  285.  
  286.  
  287.                              RECOVERING YOUR DATABASE
  288.  
  289.      "Into each life a little rain must fall."  It can happen to one's
  290.      database too.  Recovery should be done when you loose your hard disk or
  291.      when something has damaged your database.  In either case, the database
  292.      recovery procedure is the same.  True, you have to restore everything
  293.      else in a hard disk failure, but you're on your own to figure that
  294.      dilemna out.  Just the database recovery procedure is documented here.
  295.      Follow these procedures.
  296.  
  297.      #   ACTION  EVENT OR COMMAND                      COMMENT
  298.      --  ------  ----------------------------------    -----------------------
  299.      1   Type    C:                                    Move to your hard disk.
  300.  
  301.      2   Type    CD \                                  Move to the root
  302.                                                        directory.
  303.  
  304.      3   Type    VERIFY ON                             Ensure better file
  305.                                                        copies.
  306.  
  307.      4   Type    COPY KATDB.LOG KATDB.FIX              Save current log file.
  308.  
  309.      5   Type    KATLOG                                Print your current log
  310.                                                        file.
  311.  
  312.      6   Find    Latest PC-KAT database backup disks   Insert disk 1 into
  313.                                                        drive.
  314.  
  315.      7   Type    RESTORE A: C:KATDB.*                  Restore old PC-KAT
  316.                                                        database.
  317.  
  318.      8   Do      PC-KAT Integrity Analysis if not      If integrity fails go
  319.                  using a "VERIFIED" backup set.        back to step 5.
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.      TECHNICAL REFERENCE MANUAL     Copyright 1986 R.H. Martin     Page 6
  333.  
  334.  
  335.      9   Read    KATLOG printout for line # of B/U state which you're restored
  336.                  to.  Call this number "RESTORE-LINENUM".
  337.  
  338.      10  Read    KATLOG printout for last line # of printout.  Call this
  339.                  number "LAST-LINENUM".
  340.  
  341.      11  Calc    Write down what LAST-LINENUM minus RESTORE-LINENUM equals.
  342.                  Call this number STRIP-LINENUM.
  343.  
  344.      12  Type    KATSTRIP STRIP-LINENUM                Substitute real number.
  345.                                                        KATDB.FIX now contains
  346.                                                        an unsorted list of
  347.                                                        disks to reprocess.
  348.  
  349.      13  Type    SORT <KATDB.FIX >PRN                  This printout is sorted
  350.                                                        by yet-to-redo volume
  351.                                                        ID within location.
  352.  
  353.      14  DO      KAT -U or some variation              Reprocess listed
  354.                                                        diskettes.
  355.  
  356.      15  Type    DEL KATDB.FIX                         No longer needed.
  357.  
  358.      You're done!  Consider doing a PC-KAT Integrity Analysis and Backup to
  359.      preserve the recovery work you just went through.
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.